gtk_image_get_surface: Add docs
authorAlexander Larsson <alexl@redhat.com>
Sun, 22 Oct 2017 20:57:55 +0000 (22:57 +0200)
committerAlexander Larsson <alexl@redhat.com>
Sun, 22 Oct 2017 20:57:55 +0000 (22:57 +0200)
gtk/gtkimage.c

index ac9f3473ff48fe8d7b0353e09058e7554cc55bb9..d0e65f74bf57455a2ff572cc3d50fa1fb67a2916 100644 (file)
@@ -1087,6 +1087,20 @@ gtk_image_get_pixbuf (GtkImage *image)
   return _gtk_icon_helper_peek_pixbuf (&priv->icon_helper);
 }
 
+/**
+ * gtk_image_get_surface:
+ * @image: a #GtkImage
+ *
+ * Gets the image #cairo_surface_t being displayed by the #GtkImage.
+ * The storage type of the image must be %GTK_IMAGE_EMPTY or
+ * %GTK_IMAGE_SURFACE (see gtk_image_get_storage_type()).
+ * The caller of this function does not own a reference to the
+ * returned surface.
+ * 
+ * Returns: (nullable) (transfer none): the displayed surface, or %NULL if
+ *   the image is empty
+ * Since: 3.94.0
+ **/
 cairo_surface_t *
 gtk_image_get_surface (GtkImage *image)
 {